// ============================================================================
//
// LCP-net framework by Pierre CHATEL chatelp@gmail.com
// Distributed under GPLv3
// Copyright (C) THALES Land & Joint Systems, 2008, 2009. All rights reserved
//
// ============================================================================

/**
 * <copyright>
 * </copyright>
 *
 * $Id$
 */
package com.thalesgroup.preferenceFramework.models;

import org.eclipse.emf.common.util.EList;

import org.eclipse.emf.ecore.EObject;

/**
 * <!-- begin-user-doc -->
 * A representation of the model object '<em><b>Node</b></em>'.
 * <!-- end-user-doc -->
 *
 * <p>
 * The following features are supported:
 * <ul>
 *   <li>{@link com.thalesgroup.preferenceFramework.models.Node#getInArcs <em>In Arcs</em>}</li>
 *   <li>{@link com.thalesgroup.preferenceFramework.models.Node#getOutArcs <em>Out Arcs</em>}</li>
 *   <li>{@link com.thalesgroup.preferenceFramework.models.Node#getDomain <em>Domain</em>}</li>
 *   <li>{@link com.thalesgroup.preferenceFramework.models.Node#getPreferenceNetwork <em>Preference Network</em>}</li>
 * </ul>
 * </p>
 *
 * @see com.thalesgroup.preferenceFramework.models.ModelsPackage#getNode()
 * @model abstract="true"
 * @generated
 */
public interface Node extends Namable {
	/**
	 * Returns the value of the '<em><b>In Arcs</b></em>' reference list.
	 * The list contents are of type {@link com.thalesgroup.preferenceFramework.models.Arc}.
	 * It is bidirectional and its opposite is '{@link com.thalesgroup.preferenceFramework.models.Arc#getEndNode <em>End Node</em>}'.
	 * <!-- begin-user-doc -->
	 * <p>
	 * If the meaning of the '<em>In Arcs</em>' reference list isn't clear,
	 * there really should be more of a description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * @return the value of the '<em>In Arcs</em>' reference list.
	 * @see com.thalesgroup.preferenceFramework.models.ModelsPackage#getNode_InArcs()
	 * @see com.thalesgroup.preferenceFramework.models.Arc#getEndNode
	 * @model opposite="endNode"
	 * @generated
	 */
	EList<Arc> getInArcs();

	/**
	 * Returns the value of the '<em><b>Out Arcs</b></em>' reference list.
	 * The list contents are of type {@link com.thalesgroup.preferenceFramework.models.Arc}.
	 * It is bidirectional and its opposite is '{@link com.thalesgroup.preferenceFramework.models.Arc#getStartNode <em>Start Node</em>}'.
	 * <!-- begin-user-doc -->
	 * <p>
	 * If the meaning of the '<em>Out Arcs</em>' reference list isn't clear,
	 * there really should be more of a description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * @return the value of the '<em>Out Arcs</em>' reference list.
	 * @see com.thalesgroup.preferenceFramework.models.ModelsPackage#getNode_OutArcs()
	 * @see com.thalesgroup.preferenceFramework.models.Arc#getStartNode
	 * @model opposite="startNode"
	 * @generated
	 */
	EList<Arc> getOutArcs();

	/**
	 * Returns the value of the '<em><b>Domain</b></em>' containment reference list.
	 * The list contents are of type {@link com.thalesgroup.preferenceFramework.models.NodeValue}.
	 * It is bidirectional and its opposite is '{@link com.thalesgroup.preferenceFramework.models.NodeValue#getNode <em>Node</em>}'.
	 * <!-- begin-user-doc -->
	 * <p>
	 * If the meaning of the '<em>Domain</em>' containment reference list isn't clear,
	 * there really should be more of a description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * @return the value of the '<em>Domain</em>' containment reference list.
	 * @see com.thalesgroup.preferenceFramework.models.ModelsPackage#getNode_Domain()
	 * @see com.thalesgroup.preferenceFramework.models.NodeValue#getNode
	 * @model opposite="node" containment="true" required="true"
	 * @generated
	 */
	EList<NodeValue> getDomain();

	/**
	 * Returns the value of the '<em><b>Preference Network</b></em>' container reference.
	 * It is bidirectional and its opposite is '{@link com.thalesgroup.preferenceFramework.models.PreferenceNetwork#getNodes <em>Nodes</em>}'.
	 * <!-- begin-user-doc -->
	 * <p>
	 * If the meaning of the '<em>Preference Network</em>' reference isn't clear,
	 * there really should be more of a description here...
	 * </p>
	 * <!-- end-user-doc -->
	 * @return the value of the '<em>Preference Network</em>' container reference.
	 * @see #setPreferenceNetwork(PreferenceNetwork)
	 * @see com.thalesgroup.preferenceFramework.models.ModelsPackage#getNode_PreferenceNetwork()
	 * @see com.thalesgroup.preferenceFramework.models.PreferenceNetwork#getNodes
	 * @model opposite="nodes" required="true" transient="false"
	 * @generated
	 */
	PreferenceNetwork getPreferenceNetwork();

	/**
	 * Sets the value of the '{@link com.thalesgroup.preferenceFramework.models.Node#getPreferenceNetwork <em>Preference Network</em>}' container reference.
	 * <!-- begin-user-doc -->
	 * <!-- end-user-doc -->
	 * @param value the new value of the '<em>Preference Network</em>' container reference.
	 * @see #getPreferenceNetwork()
	 * @generated
	 */
	void setPreferenceNetwork(PreferenceNetwork value);

	/**
	 * Returns the direct parents of the node.
	 * 
	 * @return empty list if no parents
	 * @model
	 * @generated NOT
	 */
	EList<Node> parentNodes();

	/**
	 * Returns the direct children of the node.
	 * 
	 * @return empty list if no children
	 * @model
	 * @generated NOT
	 */
	EList<Node> childNodes();

	/**
	 * Returns the nodes used as inputs in the preference table associated to
	 * this specific node. In the case of basic CP-Nets with only Arcs (no
	 * I-Arcs nor CI-Arcs) this is equivalent to the list of parent nodes.
	 * 
	 * @return empty list if no input nodes
	 * @model
	 * @generated NOT
	 */
	EList<Node> inputNodes();

} // Node
